SetMenuExcludesMarkColumn

SetMenuExcludesMarkColumn
Header:	Menus.h		Carbon status:	Not Recommended

Sets whether a menu contains space for mark characters.

OSStatus SetMenuExcludesMarkColumn (
    MenuHandle menu, 
    Boolean excludesMark
);

menu: A handle to the menu whose width is to be set.
excludesMark: true to specify that the menu be drawn without space for mark characters; false to specify that the menu be drawn in its full width, with space for mark characters.

function result: A result code.

DISCUSSION

Your application may use the SetMenuExcludesMarkColumn function to set the width of an individual menu, so that no space is provided for mark characters such as checkmarks, dashes, or notification symbols (diamonds).

The SetMenuExcludesMarkColumn function is only recommended for use with pop-up menus, and then only in special cases. Mac OS human interface guidelines require that all standard (menu bar) menus include space for mark characters, and pop-up menus that present user-selectable attributes or commands should also contain space for marks. If a pop-up menu does not present a list of user-selectable attributes or commands, as is the case with the Mac OS 8.5 Window Manager window proxy pop-up menus that display a standard file system path, then narrowing the menu to exclude space for marks may be appropriate.

See also the GetMenuExcludesMarkColumn function.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Not recommended in Carbon. Available in CarbonLib 1.0 and later when MenusLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by MenusLib 8.5 and later.

CARBON NOTES

You should instead set the kMenuExcludesMarkColumn menu attribute using the SetMenuAttributes function.